docs: recommend pinning plugins and presets in npx command#48
Open
igordanchenko wants to merge 1 commit into
Open
docs: recommend pinning plugins and presets in npx command#48igordanchenko wants to merge 1 commit into
igordanchenko wants to merge 1 commit into
Conversation
The major-version pinning recommendation previously covered only semantic-release itself, while the npx example listed plugins and presets unpinned. An unpinned preset major can silently break releases — e.g. `conventional-changelog-conventionalcommits@10` resolved against the `conventional-changelog-writer@8` bundled by current semantic-release produces empty release notes. The example deliberately pins `conventional-changelog-conventionalcommits@9` until release-notes-generator ships with `conventional-changelog-writer@9`. See conventional-changelog/conventional-changelog#1495
Contributor
|
@igordanchenko is attempting to deploy a commit to the Semantic Release Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Extends the version pinning guidance on the Running semantic-release page to cover plugins and presets, not just semantic-release itself.
Follow-up to the discussion in conventional-changelog/conventional-changelog#1495.
Open Questions
@travi
How would you prefer to handle version drift in the pinned examples? Add a note saying the versions are current as of July 2026? Or use generic
@^X/@^Yplaceholders?A related question about the Renovate guidance: an automated Renovate config can cause the very same issue version pinning is trying to avoid — a major bump of a pinned preset (e.g.
conventional-changelog-conventionalcommits@9→@10) passes CI and silently ships empty release notes. Should the Renovate example stay semantic-release-only, or also cover plugin pins?